home *** CD-ROM | disk | FTP | other *** search
/ Sprite 1984 - 1993 / Sprite 1984 - 1993.iso / man / cmds.fmt / zctl.man < prev    next >
Text File  |  1992-11-24  |  15KB  |  397 lines
  1.  
  2.  
  3.  
  4. ZCTL                      User Commands                      ZCTL
  5.  
  6.  
  7.  
  8. NNAAMMEE
  9.      zctl - zephyr control program
  10.  
  11. SSYYNNOOPPSSIISS
  12.      zzccttll [ _o_p_t_i_o_n_s ]
  13.  
  14. DDEESSCCRRIIPPTTIIOONN
  15.      _Z_c_t_l is a general purpose control program for the _Z_e_p_h_y_r(_1)
  16.      Notification Service.  It allows the user to subscribe to
  17.      specific notice types, to save the subscriptions in a file
  18.      (default $HOME/.zephyr.subs), to change his location infor-
  19.      mation, and to send control messages to the HostManager,
  20.      _z_h_m(_8), and the WindowGram client, _z_w_g_c(_1).
  21.  
  22.      The commands may be typed on the command line, or may be
  23.      entered interactively by just typing _z_c_t_l and then typing
  24.      commands to the prompt.
  25.      NNOOTTEE:: For all commands accepting an optional _r_e_c_i_p_i_e_n_t argu-
  26.      ment, the _r_e_c_i_p_i_e_n_t defaults to your Kerberos principal.
  27.      You may also subscribe to recipient ``*''.  If you specify a
  28.      recipient, it is silently converted to ``*''.
  29.      The commands are as follows:
  30.  
  31.      aadddd _c_l_a_s_s _i_n_s_t_a_n_c_e [ _r_e_c_i_p_i_e_n_t ]
  32.                     Subscribe to _c_l_a_s_s, _i_n_s_t_a_n_c_e, _r_e_c_i_p_i_e_n_t, and
  33.                     add this triplet to the subscriptions file.
  34.  
  35.      aadddd__uunnssuubbssccrriippttiioonn _c_l_a_s_s _i_n_s_t_a_n_c_e [ _r_e_c_i_p_i_e_n_t ]
  36.                     Unsubscribe to _c_l_a_s_s, _i_n_s_t_a_n_c_e, _r_e_c_i_p_i_e_n_t,
  37.                     and add this triplet to the subscriptions
  38.                     file as an un-subscription.  For an explana-
  39.                     tion of un-subscriptions, see below.
  40.  
  41.      ccaanncceell         Cancel all subscriptions.
  42.  
  43.      ddeeffaauullttss       Retrieve the default subscription list from
  44.                     the Zephyr server.
  45.  
  46.      ddeelleettee _c_l_a_s_s _i_n_s_t_a_n_c_e [ _r_e_c_i_p_i_e_n_t ]
  47.                     Unsubscribe to _c_l_a_s_s, _i_n_s_t_a_n_c_e, _r_e_c_i_p_i_e_n_t,
  48.                     and remove this triplet from the subscrip-
  49.                     tions file.
  50.  
  51.      ddeelleettee__uunnssuubbssccrriippttiioonn _c_l_a_s_s _i_n_s_t_a_n_c_e [ _r_e_c_i_p_i_e_n_t ]
  52.                     Unsubscribe to _c_l_a_s_s, _i_n_s_t_a_n_c_e, _r_e_c_i_p_i_e_n_t,
  53.                     and remove this triplet from the subscrip-
  54.                     tions file as an un-subscription.
  55.  
  56.      ffiillee [ _f_i_l_e ]  Set default subscriptions file to _f_i_l_e.  If
  57.                     _f_i_l_e isn't specified, show what the current
  58.                     subscriptions file is.
  59.  
  60.  
  61.  
  62.  
  63. MIT Project Athena        July 1, 1988                          1
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. ZCTL                      User Commands                      ZCTL
  71.  
  72.  
  73.  
  74.      fflluusshh__llooccss     Tell the Zephyr servers to flush all location
  75.                     information associated with the user.  This
  76.                     should only be used to remove any incorrect
  77.                     data that may have been left after a system
  78.                     crash.
  79.  
  80.      hhiiddee           Hide your location as maintained by the
  81.                     Zephyr server.  This does not affect the
  82.                     value of the exposure variable (see below,
  83.                     under sseett))..
  84.  
  85.      hhmm__fflluusshh       Tell the HostManager, _z_h_m(_8), to ask the
  86.                     server to flush all state associated with the
  87.                     current host.
  88.  
  89.      lliisstt [ _f_i_l_e ]  List contents of current subscriptions file
  90.                     or _f_i_l_e. Any macros in the file (see below)
  91.                     are displayed verbatim and not expanded.
  92.  
  93.      lliisstt__rreeqquueessttss  List all available commands.  May be abbrevi-
  94.                     ated by '?'.
  95.  
  96.      llooaadd [ _f_i_l_e ]  Subscribe to all subscription triplets and
  97.                     unsubscribe to all un-subscription triplets
  98.                     in current subscriptions file or _f_i_l_e.
  99.  
  100.      nneeww__sseerrvveerr     Tell the HostManager, _z_h_m(_8), to find a new
  101.                     Zephyr server.
  102.  
  103.      qquuiitt           Exit from _z_c_t_l.
  104.  
  105.      rreettrriieevvee       Retrieve all current subscriptions from the
  106.                     Zephyr server.  These include subscriptions
  107.                     that might have been made by other programs,
  108.                     such as _z_n_o_l(_1).
  109.  
  110.      ssaavvee [ _f_i_l_e ]  Save all current subscriptions (as returned
  111.                     by the Zephyr server) into current subscrip-
  112.                     tions file or _f_i_l_e.  The file will be
  113.                     replaced.
  114.  
  115.      sseett _v_a_r [ _v_a_l_u_e ]
  116.                     Set the value of Zephyr variable _v_a_r to
  117.                     _v_a_l_u_e, or null if no _v_a_l_u_e is specified.  The
  118.                     variable eexxppoossuurree has special significance,
  119.                     and can only be set to the values none,
  120.                     opstaff, realm-visible, realm-announced,
  121.                     net-visible, and net-announced.  Setting this
  122.                     variable immediately updates the information
  123.                     in the Zephyr servers (see below for an
  124.                     explanation of the exposure levels).  In
  125.                     addition, setting this variable to none
  126.  
  127.  
  128.  
  129. MIT Project Athena        July 1, 1988                          2
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. ZCTL                      User Commands                      ZCTL
  137.  
  138.  
  139.  
  140.                     automatically performs the equivalent of a
  141.                     wwgg__sshhuuttddoowwnn command, and setting it to one of
  142.                     the other values automatically performs the
  143.                     equivalent of a wwgg__ssttaarrttuupp command.
  144.                     Any variable settings you make will be stored
  145.                     in $_H_O_M_E/._z_e_p_h_y_r._v_a_r_s
  146.  
  147.      sshhooww _v_a_r [ _v_a_r  ... ]
  148.                     Show the value of the specified Zephyr vari-
  149.                     ables.  If a variable is not defined in the
  150.                     user's own variables file, the system vari-
  151.                     ables file (/_u_s_r/_s_w_w/_l_i_b/_z_e_p_h_y_r/_z_e_p_h_y_r._v_a_r_s)
  152.                     is searched for a default value.
  153.  
  154.      ssuubbssccrriibbee _c_l_a_s_s _i_n_s_t_a_n_c_e [ _r_e_c_i_p_i_e_n_t ]
  155.                     Subscribe to _c_l_a_s_s, _i_n_s_t_a_n_c_e, _r_e_c_i_p_i_e_n_t, but
  156.                     don't add this triplet to the subscriptions
  157.                     file.
  158.  
  159.      uunnhhiiddee         Make your location as maintained by the
  160.                     Zephyr server visible.  This does not affect
  161.                     the value of the exposure variable.
  162.  
  163.      uunnllooaadd [ _f_i_l_e ]
  164.                     Unsubscribe to all subscription triplets in
  165.                     current subscriptions file or _f_i_l_e.  Un-
  166.                     subscriptions in the file are ignored.
  167.  
  168.      uunnsseett _v_a_r [ _v_a_r  ... ]
  169.                     Delete the definitions of the specified
  170.                     Zephyr variables.
  171.  
  172.      uunnssuubbssccrriibbee _c_l_a_s_s _i_n_s_t_a_n_c_e [ _r_e_c_i_p_i_e_n_t ]
  173.                     Unsubscribe to _c_l_a_s_s, _i_n_s_t_a_n_c_e, _r_e_c_i_p_i_e_n_t,
  174.                     but don't remove this triplet from the sub-
  175.                     scriptions file.
  176.  
  177.      wwgg__rreeaadd        Tell the WindowGram client, _z_w_g_c(_1), to
  178.                     reread its description file.
  179.  
  180.      wwgg__sshhuuttddoowwnn    Tell the WindowGram client to shutdown; this
  181.                     causes it to ignore all notices until a
  182.                     wg_startup command is issued.
  183.  
  184.      wwgg__ssttaarrttuupp     Tell the WindowGram client to start accepting
  185.                     notices again; useful after a wg_shutdown
  186.                     command has been issued.
  187.  
  188. MMAACCRROOSS aanndd SSUUBBSSCCRRIIPPTTIIOONN FFIILLEESS
  189.      There are three macros, %_h_o_s_t%, %_c_a_n_o_n%, and %_m_e%. %_h_o_s_t% is
  190.      converted to the current hostname, %_c_a_n_o_n% is converted to
  191.      the official hostname as returned by _g_e_t_h_o_s_t_b_y_n_a_m_e(_3), and
  192.  
  193.  
  194.  
  195. MIT Project Athena        July 1, 1988                          3
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202. ZCTL                      User Commands                      ZCTL
  203.  
  204.  
  205.  
  206.      %_m_e% is converted to your Kerberos principal.  These macros
  207.      can be used in your $_H_O_M_E/._z_e_p_h_y_r._s_u_b_s file or as arguments
  208.      to commands to specify the _c_l_a_s_s or _i_n_s_t_a_n_c_e fields.  A sam-
  209.      ple $_H_O_M_E/._z_e_p_h_y_r._s_u_b_s file might contain the following:
  210.  
  211.           message,urgent,%me%
  212.           syslog,%host%,*
  213.           mail,pop,%me%
  214.  
  215.      _Z_c_t_l reads the environment variable WWGGFFIILLEE, to find the name
  216.      of the file where the windowgram port resides.  If WWGGFFIILLEE is
  217.      not set, the file name defaults to /tmp/wg._u_i_d, where _u_i_d is
  218.      the user's UNIX uid.
  219.  
  220. UUNN--SSUUBBSSCCRRIIPPTTIIOONNSS
  221.      The zephyr server, _z_e_p_h_y_r_d(_8), maintains default subscrip-
  222.      tions which are automatically added to all users' subscrip-
  223.      tions at the time of their first subscription during a login
  224.      session.  If you wish to automatically remove some of these
  225.      default subscriptions, you use uunn--ssuubbssccrriippttiioonnss.. When you
  226.      llooaadd a subscription file containing un-subscriptions, the
  227.      un-subscriptions are automatically sent to the server as if
  228.      you had used the uunnssuubbssccrriibbee command.
  229.  
  230. EEXXPPOOSSUURREE LLEEVVEELLSS
  231.      The different exposure levels affect the operation of zephyr
  232.      and its interaction with the user, as follows:
  233.  
  234.      _n_o_n_e      This completely disables Zephyr for the user. The
  235.                user is not registered with Zephyr.  No user loca-
  236.                tion information is retained by Zephyr.  No login
  237.                or logout announcements will be sent.  No sub-
  238.                scriptions will be entered for the user, and no
  239.                notices will be displayed by _z_w_g_c(_1).
  240.  
  241.      _o_p_s_t_a_f_f   The user is registered with Zephyr.  No login or
  242.                logout announcements will be sent, and location
  243.                information will only be visible to Operations
  244.                staff.  Default subscriptions and any additional
  245.                personal subscriptions will be entered for the
  246.                user.
  247.  
  248.      _r_e_a_l_m-_v_i_s_i_b_l_e
  249.                The user is registered with Zephyr.  User location
  250.                information is retained by Zephyr and made avail-
  251.                able only to users within the user's Kerberos
  252.                realm.  No login or logout announcements will be
  253.                sent.  This is the system default.  Default sub-
  254.                scriptions and any additional personal subscrip-
  255.                tions will be entered for the user.
  256.  
  257.      _r_e_a_l_m-_a_n_n_o_u_n_c_e_d
  258.  
  259.  
  260.  
  261. MIT Project Athena        July 1, 1988                          4
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268. ZCTL                      User Commands                      ZCTL
  269.  
  270.  
  271.  
  272.                The user is registered with Zephyr.  User location
  273.                information is retained by Zephyr and made avail-
  274.                able only to users authenticated within the user's
  275.                Kerberos realm.  Login and logout announcements
  276.                will be sent, but only to users within the user's
  277.                Kerberos realm who have explicitly requested such
  278.                via subscriptions.  Default subscriptions and any
  279.                additional personal subscriptions will be entered
  280.                for the user.
  281.  
  282.      _n_e_t-_v_i_s_i_b_l_e
  283.                The user is registered with Zephyr.  User location
  284.                information is retained by Zephyr and made avail-
  285.                able to any authenticated user who requests such.
  286.                Login and logout announcements will be sent only
  287.                to users within the user's Kerberos realm who have
  288.                explicitly requested such via subscriptions.
  289.                Default subscriptions and any additional personal
  290.                subscriptions will be entered for the user.
  291.  
  292.      _n_e_t-_a_n_n_o_u_n_c_e_d
  293.                The user is registered with Zephyr. User location
  294.                information is retained by Zephyr and made avail-
  295.                able to any authenticated user who requests such.
  296.                Login and logout announcements will be sent to any
  297.                user has requested such.  Default subscriptions
  298.                and any additional personal subscriptions will be
  299.                entered for the user.
  300.  
  301. EEXXAAMMPPLLEESS
  302.      zzccttll                     Runs _z_c_t_l in interactive mode.
  303.  
  304.      zzccttll llooaadd                Load subscriptions and un-
  305.                               subscriptions from
  306.                               $_H_O_M_E/._z_e_p_h_y_r._s_u_b_s file.
  307.  
  308.      zzccttll ssuubb mmeessssaaggee ppeerrssoonnaall
  309.                               Subscribe to personal messages, but
  310.                               don't add this to the subscriptions
  311.                               file.
  312.  
  313.      zzccttll ssaavvee                Save all current subscriptions to
  314.                               the default subscriptions file.
  315.  
  316.      zzccttll sseett eexxppoossuurree nnoonnee   Set your exposure level to `none',
  317.                               effectively turning off Zephyr.
  318.  
  319. BBUUGGSS
  320.      The current implementation of the Zephyr server (_z_e_p_h_y_r_d(_8))
  321.      makes no distinction between realm-announced, net-visible
  322.      and net-announced exposure levels.
  323.  
  324.  
  325.  
  326.  
  327. MIT Project Athena        July 1, 1988                          5
  328.  
  329.  
  330.  
  331.  
  332.  
  333.  
  334. ZCTL                      User Commands                      ZCTL
  335.  
  336.  
  337.  
  338. SSEEEE AALLSSOO
  339.      zephyr(1), zwgc(1), zhm(8), zephyrd(8) gethostbyname(3)
  340.      Project Athena Technical Plan Section E.4.1, `Zephyr Notifi-
  341.      cation Service'
  342.  
  343. FFIILLEESS
  344.      /tmp/wg.*
  345.      $HOME/.zephyr.subs
  346.      $HOME/.zephyr.vars
  347.      /etc/athena/zephyr.vars
  348.  
  349. AAUUTTHHOORR
  350.      Robert S. French (MIT-Project Athena)
  351.  
  352.  
  353. RREESSTTRRIICCTTIIOONNSS
  354.      Copyright (c) 1987,1988 by the Massachusetts Institute of
  355.      Technology.  All Rights Reserved.
  356.      _z_e_p_h_y_r(_1) specifies the terms and conditions for redistribu-
  357.      tion.
  358.  
  359.  
  360.  
  361.  
  362.  
  363.  
  364.  
  365.  
  366.  
  367.  
  368.  
  369.  
  370.  
  371.  
  372.  
  373.  
  374.  
  375.  
  376.  
  377.  
  378.  
  379.  
  380.  
  381.  
  382.  
  383.  
  384.  
  385.  
  386.  
  387.  
  388.  
  389.  
  390.  
  391.  
  392.  
  393. MIT Project Athena        July 1, 1988                          6
  394.  
  395.  
  396.  
  397.